home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / sccs.arc / SCCS.DOC < prev   
Encoding:
Text File  |  1985-12-10  |  5.8 KB  |  152 lines
  1.  
  2.                                  08-Dec-1984
  3.  
  4.        This document describes delta.exe and get.exe, which are
  5.        prototypes of two support programs for what is intended to become
  6.        a full source code control system for MS-DOS machines.  The
  7.        primary module of the system is the hdiff program, a file
  8.        comparator which is available (along with documentation and some
  9.        demo files) in this database as hdiff.bin (which is actually
  10.        hdiff.lbr).  I assume here that you have the hdiff library and
  11.        have read the documentation there.
  12.  
  13.        Delta.exe and get.exe replace the two sample batch files in the
  14.        hdiff library, cdelta.bat and cget.bat.
  15.  
  16.  
  17.        General use
  18.        -----------
  19.  
  20.        The "source code control system", as currently defined, is very
  21.        modest by UNIX or mainframe standards (gradual enhancement is
  22.        planned until a real SCCS is available; bear with me).  The
  23.        current administrative programs are hdiff, delta, get, and the
  24.        DOS text editor, edlin.    Most of the "bookkeeping" is still your
  25.        responsibility.
  26.  
  27.        For a general discussion of the techniques of retaining multiple
  28.        versions of the file, see the hdiff document.  Specifics
  29.        pertaining to delta and get are as follows; the examples assume
  30.        that the source file in question is "foo.asm".
  31.  
  32.        1.  You must retain a "base" file.  This is a copy of the
  33.        earliest version of the file, and it must have the extension
  34.        "scc".  For example, the earliest version of foo.asm would be
  35.        stored in a file called foo.scc.
  36.  
  37.        2.  Version numbers are three-digit numerics; decimal point is
  38.        irrelevant as far as delta and get are concerned.  Difference
  39.        files are stored as foo.110, foo.111, foo.120, and so on
  40.        (versions 1.10, 1.11, and 1.20).  These files contain edlin
  41.        scripts which will convert foo.scc into foo.asm; for example,
  42.        foo.scc + foo.120 => foo.asm, version 1.20.
  43.  
  44.        3.  Delta uses hdiff, which must therefore be online at the time
  45.        delta is run (either in the same directory or in any directory
  46.        which will be searched according to the current PATH).  Get uses
  47.        edlin, which must be similarly available.
  48.  
  49.        4.  For the present, the source-related files must be in the same
  50.        directory: the base (.scc) file and the current version of the
  51.        source (for delta), or the base file and the required difference
  52.        file (for get).
  53.  
  54.  
  55.        Delta
  56.        -----
  57.  
  58.        Delta uses hdiff to build a difference file.  The syntax is:
  59.  
  60.         delta [-maxlines] [path]file.ext [ver]
  61.  
  62.        The -maxlines switch is identical to the equivalent switch in
  63.        hdiff (in fact, it is passed to hdiff unaltered).  The file
  64.        specification is the name of the file containing the current
  65.        version of the source; it will be hdiff'd with [d:path\]file.scc.
  66.        The version parameter specifies the version number; it will be
  67.        used as the extension of the difference file.  For example:
  68.  
  69.         delta -3000 c:foo.asm 125
  70.  
  71.        will execute hdiff, setting maxlines to 3000; hdiff will be
  72.        instructed to compare c:foo.scc and c:foo.asm, and the resulting
  73.        difference file will be written to c:foo.125.
  74.  
  75.        If the version is omitted, hdiff will create a difference file
  76.        with an extension equal to the highest extension found, plus one.
  77.        E.g., if the latest foo.ver file is foo.120, delta will create
  78.        foo.121.  If no version number is specified, and delta cannot
  79.        find any old differences file, it will create version 1.00.
  80.  
  81.        Note that delta does not examine the maxlines switch; it is
  82.        simply passed to hdiff without comment.    If the switch is invalid
  83.        for any reason, hdiff will issue a message and cancel.  Delta
  84.        will nonetheless report a successful run; this message should be
  85.        ignored.
  86.  
  87.  
  88.        Get
  89.        ---
  90.  
  91.        Get creates a full source file by combining a base (.scc) file
  92.        and a difference file.  The syntax is:
  93.  
  94.         get [path]file.ext [ver]
  95.  
  96.        For example,
  97.  
  98.         get c:\util\foo.asm 120
  99.  
  100.        will combine c:\util\foo.scc and c:\util\foo.120 (using edlin) to
  101.        create c:\util\foo.asm.    If the version number is omitted, get
  102.        will retrieve the highest numbered version it can find.    For,
  103.        example, if the directory contains:
  104.  
  105.         foo.scc
  106.         foo.125
  107.         foo.120
  108.         foo.130
  109.         foo.110
  110.  
  111.        the command
  112.  
  113.         get foo.asm
  114.  
  115.        will create a copy of version 1.30.  Note that version numbers
  116.        containing alpha characters (like foo.12A) will not parse
  117.        correctly and will be ignored, so I suggest that you stick with
  118.        all numeric version numbers.
  119.  
  120.        Note that the typical use of delta and get will be very simple:
  121.  
  122.         delta foo.asm
  123.         get foo.asm
  124.  
  125.  
  126.        The usual caveat
  127.        ----------------
  128.  
  129.        Please consider all three modules (hdiff, get, and delta) to be
  130.        experimental or beta test versions.  Hdiff has proven thus far to
  131.        be reliable, but it is a fairly tricky program and there could be
  132.        errors.    Until more experience is gained, I suggest that you use
  133.        the following technique when storing a new version:
  134.  
  135.         delta foo.asm
  136.         get foo.tmp
  137.         comp foo.asm foo.tmp
  138.  
  139.        If there are any problems, they will be reported by the "comp"
  140.        step.  Please report such problems to me.  If foo.asm and foo.tmp
  141.        compare OK, you can safely erase both files.
  142.  
  143.  
  144.            ---------------------------------------
  145.  
  146.          Hdiff.exe, get.exe, delta.exe, and this document are
  147.                 Copyright (c) 1984 by
  148.                 Christopher J. Dunford
  149.                10057-2 Windstream Drive
  150.                   Columbia, MD 21044
  151.                 CIS 71076,1115